API

Procurement APIs

PUT procurement/imported-invoices/{importedSupplierInvoiceId}

Saves information about the imported supplier invoice

HTTP method PUT
URI https://api.rambase.net/procurement/imported-invoices/{importedSupplierInvoiceId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {importedSupplierInvoiceId} Imported supplier invoice identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 2822, version 22

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<ImportedSupplierInvoice
ImportedSupplierInvoice

This field is optional.

>
2
     <ExternalReference
ExternalReference

Unique identifier of the file. Used to make sure that the same file is not procesed more than once.

This field is optional.

>{String}</ExternalReference>
3
     <RegistrationDate
RegistrationDate

The issue date to the invoice

This field is optional.

>{Date}</RegistrationDate>
4
     <SuppliersReference
SuppliersReference

The reference to the imported supplier invoice

This field is optional.

>{String}</SuppliersReference>
5
     <SuppliersReferenceNumber
SuppliersReferenceNumber

Supplier invoice number generated by the supplier invoicing system

This field is optional.

>{String}</SuppliersReferenceNumber>
6
     <Currency
Currency

The currency to the imported supplier invoice

This field is optional.

>{String}</Currency>
7
     <IsCreditNote
IsCreditNote

Is the imported invoice from type credit note

This field is optional.

>{Boolean}</IsCreditNote>
8
     <BuyersContact
BuyersContact

This field is optional.

>
9
          <Name
Name

Name of the RamBase contact (legal entity or person)

This field is optional.

>{String}</Name>
10
          <Phone
Phone

Phone number of the RamBase contact

This field is optional.

>{String}</Phone>
11
          <Email
Email

E-mail of the RamBase contact

This field is optional.

>{String}</Email>
12
     </BuyersContact>
13
     <VATAccounting
VATAccounting

This field is optional.

>
14
          <Currency
Currency

The currency used for VAT to the imported supplier invoice

This field is optional.

>{String}</Currency>
15
          <Date
Date

The date when the VAT becomes accountable

This field is optional.

>{Date}</Date>
16
          <VATAmount
VATAmount

Total amount of VAT in VAT currency on the invoice

This field is optional.

>{Decimal}</VATAmount>
17
          <VATRegistrationNumber
VATRegistrationNumber

VAT registration number of the company which should be used for the invoice or credit.

This field is optional.

>{String}</VATRegistrationNumber>
18
     </VATAccounting>
19
     <Totals
Totals

This field is optional.

>
20
          <FreightAmount
FreightAmount

Freight of the invoice

This field is optional.

>{Decimal}</FreightAmount>
21
          <FeeAmount
FeeAmount

Fee of the invoice

This field is optional.

>{Decimal}</FeeAmount>
22
          <SubTotalAmount
SubTotalAmount

Total net amount on the invoice

This field is optional.

>{Decimal}</SubTotalAmount>
23
          <VATAmount
VATAmount

Total amount of VAT on the invoice

This field is optional.

>{Decimal}</VATAmount>
24
          <TotalAmount
TotalAmount

Total net amount on the invoice

This field is optional.

>{Decimal}</TotalAmount>
25
          <RoundOffAmount
RoundOffAmount

The round off to the imported supplier invoice

This field is optional.

>{Decimal}</RoundOffAmount>
26
     </Totals>
27
     <Payment
Payment

This field is optional.

>
28
          <DueDate
DueDate

The due date of the imported supplier invoice

This field is optional.

>{Date}</DueDate>
29
          <AccountName
AccountName

The bank account name to the payment receiver

This field is optional.

>{String}</AccountName>
30
          <AccountNumber
AccountNumber

The bank account number to the payment receiver

This field is optional.

>{String}</AccountNumber>
31
          <IBAN
IBAN

The international bank account number (IBAN) to the payment receiver

This field is optional.

>{String}</IBAN>
32
          <SWIFTCode
SWIFTCode

The bank identification code (BIC) to the account to the payment receiver

This field is optional.

>{String}</SWIFTCode>
33
          <SuppliersReference
SuppliersReference

The reference to the payment receiver

This field is optional.

>{String}</SuppliersReference>
34
     </Payment>
35
     <Supplier
Supplier

This field is optional.

>
36
          <Name
Name

The name of the supplier

This field is optional.

>{String}</Name>
37
          <LegalEntityIdentifier
LegalEntityIdentifier

The enterprise number to the supplier

This field is optional.

>{String}</LegalEntityIdentifier>
38
          <InvoiceAddress
InvoiceAddress

This field is optional.

>
39
               <Attention
Attention

The attention to the supplier

This field is optional.

>{String}</Attention>
40
               <AddressLine1
AddressLine1

The street name to the supplier

This field is optional.

>{String}</AddressLine1>
41
               <AddressLine2
AddressLine2

The additional street name to the supplier

This field is optional.

>{String}</AddressLine2>
42
               <Region
Region

The state to the supplier

This field is optional.

>{String}</Region>
43
               <PostalCode
PostalCode

The postal code to the supplier

This field is optional.

>{String}</PostalCode>
44
               <City
City

The city to the supplier

This field is optional.

>{String}</City>
45
               <CountryCode
CountryCode

The country code to the supplier

This field is optional.

>{String}</CountryCode>
46
          </InvoiceAddress>
47
          <SupplierReference
SupplierReference

The account to the supplier

This field is optional.

>
48
               <SupplierId
SupplierId

RamBase supplier identifier

Minimum value: 100

This field is optional.

>{Integer}</SupplierId>
49
          </SupplierReference>
50
          <Contact
Contact

This field is optional.

>
51
               <Name
Name

Name of the suppliers contact (legal entity or person)

This field is optional.

>{String}</Name>
52
               <Phone
Phone

Phone number of the suppliers contact

This field is optional.

>{String}</Phone>
53
               <Email
Email

E-mail of the suppliers contact

This field is optional.

>{String}</Email>
54
          </Contact>
55
     </Supplier>
56
     <ShippedFrom
ShippedFrom

This field is optional.

>
57
          <AddressLine1
AddressLine1

The street name to the shipped from address

This field is optional.

>{String}</AddressLine1>
58
          <AddressLine2
AddressLine2

The additional street name to the shipped from address

This field is optional.

>{String}</AddressLine2>
59
          <PostalCode
PostalCode

The postal code to the shipped from address

This field is optional.

>{String}</PostalCode>
60
          <City
City

The city to the shipped from address

This field is optional.

>{String}</City>
61
          <Region
Region

The state to the shipped from address

This field is optional.

>{String}</Region>
62
          <CountryCode
CountryCode

The country code to the shipped from address

This field is optional.

>{String}</CountryCode>
63
          <AddressReferences
AddressReferences

The identifier to the shipped from address

This field is optional.

>
64
               <AddressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

>{Integer}</AddressId>
65
          </AddressReferences>
66
     </ShippedFrom>
67
     <ShippedTo
ShippedTo

This field is optional.

>
68
          <AddressLine1
AddressLine1

The street name of the shipped to address

This field is optional.

>{String}</AddressLine1>
69
          <AddressLine2
AddressLine2

The additional street name of the shipped to address

This field is optional.

>{String}</AddressLine2>
70
          <PostalCode
PostalCode

The postal code to the shipped to address

This field is optional.

>{String}</PostalCode>
71
          <City
City

The city to the shipped to address

This field is optional.

>{String}</City>
72
          <Region
Region

The state of the shipped to address

This field is optional.

>{String}</Region>
73
          <CountryCode
CountryCode

The country code to the shipped to address

This field is optional.

>{String}</CountryCode>
74
          <AddressReference
AddressReference

Reference to the shipped to address. Can be a reference to location address, customer address or supplier address

This field is optional.

>
75
               <Reference
Reference

This field is optional.

>
76
                    <ObjectId
ObjectId

Identifier of the object

Minimum value: 10000

This field is optional.

>{Integer}</ObjectId>
77
                    <ObjectType
ObjectType

Type of object

This field is optional.

>{String}</ObjectType>
78
                    <ItemId
ItemId

Item-number of the object

Minimum value: 1

This field is optional.

>{Integer}</ItemId>
79
                    <ItemType
ItemType

Type of item

This field is optional.

>{String}</ItemType>
80
               </Reference>
81
          </AddressReference>
82
     </ShippedTo>
83
</ImportedSupplierInvoice>
1
{
2
     "importedSupplierInvoice
ImportedSupplierInvoice

This field is optional.

": {
3
          "externalReference
ExternalReference

Unique identifier of the file. Used to make sure that the same file is not procesed more than once.

This field is optional.

": "{String}",
4
          "registrationDate
RegistrationDate

The issue date to the invoice

This field is optional.

": "{Date}",
5
          "suppliersReference
SuppliersReference

The reference to the imported supplier invoice

This field is optional.

": "{String}",
6
          "suppliersReferenceNumber
SuppliersReferenceNumber

Supplier invoice number generated by the supplier invoicing system

This field is optional.

": "{String}",
7
          "currency
Currency

The currency to the imported supplier invoice

This field is optional.

": "{String}",
8
          "isCreditNote
IsCreditNote

Is the imported invoice from type credit note

This field is optional.

": "{Boolean}",
9
          "buyersContact
BuyersContact

This field is optional.

": {
10
               "name
Name

Name of the RamBase contact (legal entity or person)

This field is optional.

": "{String}",
11
               "phone
Phone

Phone number of the RamBase contact

This field is optional.

": "{String}",
12
               "email
Email

E-mail of the RamBase contact

This field is optional.

": "{String}"
13
          },
14
          "vATAccounting
VATAccounting

This field is optional.

": {
15
               "currency
Currency

The currency used for VAT to the imported supplier invoice

This field is optional.

": "{String}",
16
               "date
Date

The date when the VAT becomes accountable

This field is optional.

": "{Date}",
17
               "vATAmount
VATAmount

Total amount of VAT in VAT currency on the invoice

This field is optional.

": "{Decimal}",
18
               "vATRegistrationNumber
VATRegistrationNumber

VAT registration number of the company which should be used for the invoice or credit.

This field is optional.

": "{String}"
19
          },
20
          "totals
Totals

This field is optional.

": {
21
               "freightAmount
FreightAmount

Freight of the invoice

This field is optional.

": "{Decimal}",
22
               "feeAmount
FeeAmount

Fee of the invoice

This field is optional.

": "{Decimal}",
23
               "subTotalAmount
SubTotalAmount

Total net amount on the invoice

This field is optional.

": "{Decimal}",
24
               "vATAmount
VATAmount

Total amount of VAT on the invoice

This field is optional.

": "{Decimal}",
25
               "totalAmount
TotalAmount

Total net amount on the invoice

This field is optional.

": "{Decimal}",
26
               "roundOffAmount
RoundOffAmount

The round off to the imported supplier invoice

This field is optional.

": "{Decimal}"
27
          },
28
          "payment
Payment

This field is optional.

": {
29
               "dueDate
DueDate

The due date of the imported supplier invoice

This field is optional.

": "{Date}",
30
               "accountName
AccountName

The bank account name to the payment receiver

This field is optional.

": "{String}",
31
               "accountNumber
AccountNumber

The bank account number to the payment receiver

This field is optional.

": "{String}",
32
               "iBAN
IBAN

The international bank account number (IBAN) to the payment receiver

This field is optional.

": "{String}",
33
               "sWIFTCode
SWIFTCode

The bank identification code (BIC) to the account to the payment receiver

This field is optional.

": "{String}",
34
               "suppliersReference
SuppliersReference

The reference to the payment receiver

This field is optional.

": "{String}"
35
          },
36
          "supplier
Supplier

This field is optional.

": {
37
               "name
Name

The name of the supplier

This field is optional.

": "{String}",
38
               "legalEntityIdentifier
LegalEntityIdentifier

The enterprise number to the supplier

This field is optional.

": "{String}",
39
               "invoiceAddress
InvoiceAddress

This field is optional.

": {
40
                    "attention
Attention

The attention to the supplier

This field is optional.

": "{String}",
41
                    "addressLine1
AddressLine1

The street name to the supplier

This field is optional.

": "{String}",
42
                    "addressLine2
AddressLine2

The additional street name to the supplier

This field is optional.

": "{String}",
43
                    "region
Region

The state to the supplier

This field is optional.

": "{String}",
44
                    "postalCode
PostalCode

The postal code to the supplier

This field is optional.

": "{String}",
45
                    "city
City

The city to the supplier

This field is optional.

": "{String}",
46
                    "countryCode
CountryCode

The country code to the supplier

This field is optional.

": "{String}"
47
               },
48
               "supplierReference
SupplierReference

The account to the supplier

This field is optional.

": {
49
                    "supplierId
SupplierId

RamBase supplier identifier

Minimum value: 100

This field is optional.

": "{Integer}"
50
               },
51
               "contact
Contact

This field is optional.

": {
52
                    "name
Name

Name of the suppliers contact (legal entity or person)

This field is optional.

": "{String}",
53
                    "phone
Phone

Phone number of the suppliers contact

This field is optional.

": "{String}",
54
                    "email
Email

E-mail of the suppliers contact

This field is optional.

": "{String}"
55
               }
56
          },
57
          "shippedFrom
ShippedFrom

This field is optional.

": {
58
               "addressLine1
AddressLine1

The street name to the shipped from address

This field is optional.

": "{String}",
59
               "addressLine2
AddressLine2

The additional street name to the shipped from address

This field is optional.

": "{String}",
60
               "postalCode
PostalCode

The postal code to the shipped from address

This field is optional.

": "{String}",
61
               "city
City

The city to the shipped from address

This field is optional.

": "{String}",
62
               "region
Region

The state to the shipped from address

This field is optional.

": "{String}",
63
               "countryCode
CountryCode

The country code to the shipped from address

This field is optional.

": "{String}",
64
               "addressReferences
AddressReferences

The identifier to the shipped from address

This field is optional.

": {
65
                    "addressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

": "{Integer}"
66
               }
67
          },
68
          "shippedTo
ShippedTo

This field is optional.

": {
69
               "addressLine1
AddressLine1

The street name of the shipped to address

This field is optional.

": "{String}",
70
               "addressLine2
AddressLine2

The additional street name of the shipped to address

This field is optional.

": "{String}",
71
               "postalCode
PostalCode

The postal code to the shipped to address

This field is optional.

": "{String}",
72
               "city
City

The city to the shipped to address

This field is optional.

": "{String}",
73
               "region
Region

The state of the shipped to address

This field is optional.

": "{String}",
74
               "countryCode
CountryCode

The country code to the shipped to address

This field is optional.

": "{String}",
75
               "addressReference
AddressReference

Reference to the shipped to address. Can be a reference to location address, customer address or supplier address

This field is optional.

": {
76
                    "reference
Reference

This field is optional.

": {
77
                         "objectId
ObjectId

Identifier of the object

Minimum value: 10000

This field is optional.

": "{Integer}",
78
                         "objectType
ObjectType

Type of object

This field is optional.

": "{String}",
79
                         "itemId
ItemId

Item-number of the object

Minimum value: 1

This field is optional.

": "{Integer}",
80
                         "itemType
ItemType

Type of item

This field is optional.

": "{String}"
81
                    }
82
               }
83
          }
84
     }
85
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101079 HTTP 400 Mismatch in size of revision parameters